Skip to content

Add AGENTS.md at repo root#595

Open
tbeaudouin05 wants to merge 1 commit intosipeed:mainfrom
tbeaudouin05:Add-AGENTS.md-at-repo-root
Open

Add AGENTS.md at repo root#595
tbeaudouin05 wants to merge 1 commit intosipeed:mainfrom
tbeaudouin05:Add-AGENTS.md-at-repo-root

Conversation

@tbeaudouin05
Copy link

📝 Description

Add AGENTS.md to capture the agent working agreement so everyone—humans or AI assistants—consistently follows the same coding standards, documentation expectations, testing requirements, and the make test gate after any change.

🗣️ Type of Change

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 📖 Documentation update
  • ⚡ Code refactoring (no functional changes, no api changes)

🤖 AI Code Generation

  • 🤖 Fully AI-generated (100% AI, 0% Human)
  • 🛠️ Mostly AI-generated (AI draft, Human verified/modified)
  • 👨‍💻 Mostly Human-written (Human lead, AI assisted or none)

🔗 Related Issue

📚 Technical Context (Skip for Docs)

  • Reference URL:
  • Reasoning: Establishes a single, repo-local policy so contributors (including AI agents) reliably adhere to style, docs updates, unit tests, and running make test after changes.

🧪 Test Environment

  • Hardware:
  • OS:
  • Model/Provider:
  • Channels:

Copy link

@nikolasdehor nikolasdehor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intent is good — having a standardized AGENTS.md for AI coding agents to follow is useful. However, this file is quite sparse for its purpose. A few suggestions:

  1. Add project-specific context. The current rules are generic enough to apply to any repo. An AGENTS.md is most useful when it captures project-specific conventions:

    • Go version requirement (1.25+)
    • make check runs gofmt, go vet, and go test — mention this
    • Conventional commit format for commit messages
    • Config changes should go through pkg/config/defaults.go not manual JSON
    • Security-sensitive areas: auth providers, channel allowlists, exec tool
    • Test patterns: table-driven tests, httptest for channel handlers
  2. make test may not be sufficient. The project uses make check which includes gofmt and go vet in addition to tests. Consider specifying make check instead.

  3. Consider adding a "do not" section. E.g.:

    • Do not add new dependencies without justification
    • Do not modify go.sum manually
    • Do not expose config tokens/keys in error messages or logs

As-is, the content is correct but would benefit from being more actionable and project-specific. Not blocking since any AGENTS.md is better than none.

@sipeed-bot sipeed-bot bot added the type: documentation Improvements or additions to documentation label Mar 3, 2026
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants